DataModel

[GET] /api/v2/data/data-models/analysis-models/{documentId}/download

下载模型文档。

参数:

名称	类型	位置	描述
documentId必填项	string	path	文档编号。例如：b48bb95f-7bb7-c55b-c251-b118e6bee4bb

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/data-models/{id}/query

查询数据模型。

参数:

名称	类型	位置	描述
id必填项	string	path	数据模型ID
query	string	query	查询
queryType	string	query	查询类型
format	string	query	格式
UnknownTypeHandle	string	query	未知类型处理方式
MissParameterHandle	string	query	缺少参数处理方式
RowLimit	string	query	行限制

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/data-models/{id}/query

查询数据模型。

参数:

名称	类型	位置	描述
id必填项	string	path	数据模型ID

请求数据格式

QueryDataModelRequestBody

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/data-models/analysis-models/batch-rebuild-cache

重建缓存的模型缓存。

请求数据格式

BatchRebuildModelsRequestViewModelV2

返回值

状态码: 200

成功

RebuildModelCacheResponseViewModelV2

状态码: 400

错误的请求

AnalysisModelErrorV2

[POST] /api/v2/data/data-models/cache-models/{documentId}/sync

启动加载数据任务，根据数据源中的表结构重新加载数据。由设计器中的同步功能触发。

参数:

名称	类型	位置
documentId必填项	string	path

请求数据格式

SyncEntitiesRequestViewModelV2

返回值

状态码: 200

成功

SyncEntitiesResponseModelV2

状态码: 400

错误的请求

AnalysisModelErrorV2

状态码: 404

未找到

AnalysisModelErrorV2

类型定义

Ƭ DatasetPluginErrorV2

数据集插件错误模型

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginErrorV2
extendedResult可为空	any	扩展结果

Ƭ QueryDataModelRequestBody

查询数据模型请求体

名称	类型	描述
datasourceParameters可为空	string	数据源参数
query可为空	string	查询
queryType可为空	string	查询类型
format可为空	string	格式
options	Options

Ƭ Options

名称	类型	描述
unknownTypeHandle可为空	string	未知类型处理方式
missParameterHandle可为空	string	缺少参数处理方式
rowLimit可为空	string	行限制

Ƭ RebuildModelCacheResponseViewModelV2

表示重建模型缓存响应模型。

名称	类型	描述
documentId可为空	string	文档编号。
succeeded	Boolean	重建任务的结果。
errorCode	int32	重建失败时的错误代码。
errorMessage可为空	string	重建失败时出现错误消息。
modified	ISO DateTime Sting	重建缓存数据时间。

Ƭ AnalysisModelErrorV2

分析模型插件错误模型

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	AnalysisModelErrorV2
extendedResult可为空	any	扩展结果

Ƭ BatchRebuildModelsRequestViewModelV2

代表批量重建模型。

名称	类型	描述	示例
documentIds	`Array<string>`	文档 ID 数组	`["5b0a797d-3f47-420e-a34b-37b3fd9ed934","d5b53d25-cb57-43a5-a027-cac17522e785"]`

Ƭ SyncEntitiesResponseModelV2

表示同步表数据响应模型。

名称	类型	描述	示例
queryId可为空	string	任务ID，可用于查询任务进度。

Ƭ SyncEntitiesRequestViewModelV2

表示同步表请求模型。

名称	类型	描述	示例
lockNo	string	当前文档的锁定号。	`"0acd06af-2077-4cff-976a-76061a1dd626"`
dataSourceInfos	DataSourceInfoViewModel	缓存模型的数据源列表。
entities	EntityViewModel	需要同步的表。

Ƭ DataSourceInfoViewModel

表示数据源模型。

名称	类型	描述	示例
id	string	数据源 ID。	`"8b8b1cc9-413c-4ba0-8563-824153dde1e7"`
type	ViewModelDataSourceType
provider	string	数据源提供者。	`"Oracle"`
connectionString可为空	string	数据源连接字符串。
documentId可为空	string	引用的数据源文档 ID。	`"79590916-839a-4a99-a634-98e7f502c4b9"`
documentVersion可为空	int32	引用的数据源文档版本。

Ƭ EntityViewModel

代表一个表模型。

名称	类型	描述	示例
id	string	表 ID。	`"47732d38-f453-432b-8d3d-b6d4e2227ad"`
name	string	表名称。	`"userName"`
binding	string	表绑定。	`"[dbo].[User]"`
bindingType	ViewModelEntityBindingType
attributes	AttributeViewModel	表的属性。
isHidden	Boolean	指示表是否隐藏。
entityParameterCollection	EntityParameterCollectionViewModel
dataSourceId	string	当前表所属数据源的id。	`"af3c4241-a6b2-4a86-90d0-4eda941856eb"`
generatedName可为空	string	保留字段，暂时不用。
isSupportIncrementalUpdate	Boolean	指示当前表是否支持增量更新。	`true`

Ƭ ViewModelDataSourceType

Enum:

Embedded
Referenced

数据源类型。

* embedded - 0 - 嵌入数据源。
* referenced - 1 - 引用数据源。

Ƭ ViewModelEntityBindingType

Enum:

DatabaseTable
CustomSQLTable
LocalEntity

表绑定类型。

* databasetable - 0 - 数据库表。
* customsqltable - 1 - 自定义 SQL 语句表。
* localentity - 2 - 本地表。

Ƭ AttributeViewModel

表示属性模型。

名称	类型	描述	示例
id	string	属性 ID。	`"a9d47ea8-aa33-4af6-943f-548abf0db44e"`
name	string	属性名称。	`"userName"`
binding	string	属性绑定。
isNullable	Boolean	该属性是否可为空。	`true`
isUnique	Boolean	指示属性值是否唯一。
bindingType	ViewModelAttributeBindingType
dataType	ViewModelAttributeLogicalDataType
dataVizAIHint	ViewModelDataVizAIHint
clrDataTypeName	string	属性的公共语言运行时 (clr) 数据类型的名称。	`"System.String"`
isHidden	Boolean	指示该属性是否隐藏。
isDate	Boolean	指示属性是否为日期。
generatedName可为空	string	保留字段，暂时不用。
isContainTimeZone可为空	Boolean	指示属性值是否包含时区。
originName可为空	string	属性的原始名称。	`"name"`
isUnsupported可为空	Boolean	指示属性类型是否不受支持。

Ƭ EntityParameterCollectionViewModel

表示Web json数据源表的参数集合。

名称	类型	描述	示例
entityParameters	EntityParameterViewModel	表参数列表。

Ƭ ViewModelAttributeBindingType

Enum:

DatabaseTableColumn
PrimitiveSQLExpression

属性绑定类型。

* databasetablecolumn - 0 - 数据库表列
* primitivesqlexpression - 1 - 自定义 SQL 表达式列

Ƭ ViewModelAttributeLogicalDataType

Enum:

Number
Text
Boolean
Binary
GUID
Date
DateTime
Unknown

属性数据类型。

* number - 0 - 数字
* text - 1 - 文本
* boolean - 2 - 布尔值
* binary - 3 - 二进制
* guid - 4 - GUID
* date - 5 - 日期
* datetime - 6 - 日期时间
* unknown - 7 - 未知类型

Ƭ ViewModelDataVizAIHint

Enum:

None
Currency
ImageURL
ImageBinary
GeoRegion
GeoLatitude
GeoLongitude

DataVizAIHint

* none - 0 - 无。
* currency - 1 - 货币。
* imageurl - 2 - 图像 URL。
* imagebinary - 3 - 二进制图像。
* georegion - 4 - 地理区域。
* geolatitude - 5 - 地理纬度。
* geolongitude - 6 - 地理经度.

Ƭ EntityParameterViewModel

表示表参数视图模型。

名称	类型	描述	示例
parameterName	string	参数名称。	`"name"`
literalValue可为空	string	参数值显示为文本。	`"Bob"`
valueType	ViewModelAttributeLogicalDataType
isMultivalued	Boolean	当前参数是否为多值参数。